Skip to main content
PATCH
/
placement_catalogs
Update a placement catalog
curl --request PATCH \
  --url https://your_a2_service/placement_catalogs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "no": 123,
  "placement_ids": [
    "<string>"
  ],
  "settings": {
    "include_analytics": false,
    "indicators": []
  },
  "updated_at": "2023-11-07T05:31:56Z"
}'
{
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "no": 123,
  "placement_ids": [
    "<string>"
  ],
  "settings": {
    "include_analytics": false,
    "indicators": []
  },
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

โ€‹
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Schema for updating a placement catalog.

โ€‹
created_by
string<uuid>
required

The ID of the user who created the placement catalog

โ€‹
description
string
required

The description in JSON Quill Delta format - a JSON format that represents rich text content
Links: https://quilljs.com/docs/delta

โ€‹
id
string<uuid>
required
โ€‹
name
string
required

The name of the placement catalog

โ€‹
no
integer
required
โ€‹
placement_ids
string[]
required

The list of placement IDs

โ€‹
settings
object
required

Schema for placement catalog settings.

โ€‹
created_at
string<date-time> | null

The date and time the entity was created.

โ€‹
updated_at
string<date-time> | null

The date and time the entity was last updated.

Response

Successful Response

Schema for reading a placement catalog.

โ€‹
created_by
string<uuid>
required

The ID of the user who created the placement catalog

โ€‹
description
string
required

The description in JSON Quill Delta format - a JSON format that represents rich text content
Links: https://quilljs.com/docs/delta

โ€‹
id
string<uuid>
required
โ€‹
name
string
required

The name of the placement catalog

โ€‹
no
integer
required
โ€‹
placement_ids
string[]
required

The list of placement IDs

โ€‹
settings
object
required

Schema for placement catalog settings.

โ€‹
created_at
string<date-time> | null

The date and time the entity was created.

โ€‹
updated_at
string<date-time> | null

The date and time the entity was last updated.